<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="CollectionEvent,mx.events.CollectionEvent,COLLECTION_CHANGE,items,kind,location,oldLocation" name="keywords">
<title>mx.events.CollectionEvent</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'CollectionEvent - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/events/CollectionEvent.html&amp;mx/events/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;CollectionEvent</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class CollectionEvent"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.events</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CollectionEvent</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CollectionEvent <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.events.Event</td>
</tr>
</table>
<p></p>
  The mx.events.CollectionEvent class represents an event that is  
  dispatched when the associated collection changes.
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="FlexEvent.html#CURSOR_UPDATE" target="">FlexEvent.CURSOR_UPDATE</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#items">items</a> : Array<div class="summaryTableDescription">
   When the <code>kind</code> is <code>CollectionEventKind.ADD</code>
      or <code>CollectionEventKind.REMOVE</code> the <code>items</code> property
      is an Array of added/removed items.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#kind">kind</a> : String<div class="summaryTableDescription">
      Indicates the kind of event that occurred.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#location">location</a> : int<div class="summaryTableDescription">
      When the <code>kind</code> value is <code>CollectionEventKind.ADD</code>,
      <code>CollectionEventKind.MOVE</code>,
      <code>CollectionEventKind.REMOVE</code>, or
      <code>CollectionEventKind.REPLACE</code>, this property is the 
   zero-base index in the collection of the item(s) specified in the 
   <code>items</code> property.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#oldLocation">oldLocation</a> : int<div class="summaryTableDescription">
      When the <code>kind</code> value is <code>CollectionEventKind.MOVE</code>,
      this property is the zero-based index in the target collection of the
      previous location of the item(s) specified by the <code>items</code> property.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#CollectionEvent()">CollectionEvent</a>(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)</div>
<div class="summaryTableDescription">
      Constructor.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COLLECTION_CHANGE">COLLECTION_CHANGE</a> : String = "collectionChange"<div class="summaryTableDescription">[static]
      The CollectionEvent.COLLECTION_CHANGE constant defines the value of the
      <code>type</code> property of the event object for an event that is
      dispatched when a collection has changed.</div>
</td><td class="summaryTableOwnerCol">CollectionEvent</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="items"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">items</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>public var items:Array</code><p>
   When the <code>kind</code> is <code>CollectionEventKind.ADD</code>
      or <code>CollectionEventKind.REMOVE</code> the <code>items</code> property
      is an Array of added/removed items.
   When the <code>kind</code> is <code>CollectionEventKind.REPLACE</code>
      or <code>CollectionEventKind.UPDATE</code> the <code>items</code> property
      is an Array of PropertyChangeEvent objects with information about the items
      affected by the event.
      When a value changes, query the <code>newValue</code> and
      <code>oldValue</code> fields of the PropertyChangeEvent objects
      to find out what the old and new values were.
      When the <code>kind</code> is <code>CollectionEventKind.REFRESH</code>
      or <code>CollectionEventKind.RESET</code>, this array has zero length.
           </p><p>The default value is <code>[ ]</code>.</p>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="PropertyChangeEvent.html" target="">PropertyChangeEvent</a>
</div>
</div>
<a name="kind"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">kind</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var kind:String</code><p>
      Indicates the kind of event that occurred.
      The property value can be one of the values in the 
   CollectionEventKind class, 
   or <code>null</code>, which indicates that the kind is unknown.
  
      </p><p>The default value is <code>null</code>.</p>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="CollectionEventKind.html" target="">CollectionEventKind</a>
</div>
</div>
<a name="location"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">location</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var location:int</code><p>
      When the <code>kind</code> value is <code>CollectionEventKind.ADD</code>,
      <code>CollectionEventKind.MOVE</code>,
      <code>CollectionEventKind.REMOVE</code>, or
      <code>CollectionEventKind.REPLACE</code>, this property is the 
   zero-base index in the collection of the item(s) specified in the 
   <code>items</code> property.
           </p><p>The default value is <code>-1</code>.</p>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="CollectionEventKind.html" target="">CollectionEventKind</a>
</div>
</div>
<a name="oldLocation"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">oldLocation</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var oldLocation:int</code><p>
      When the <code>kind</code> value is <code>CollectionEventKind.MOVE</code>,
      this property is the zero-based index in the target collection of the
      previous location of the item(s) specified by the <code>items</code> property.
           </p><p>The default value is <code>-1</code>.</p>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="CollectionEvent()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">CollectionEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)</code><p>
      Constructor.
        </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">type</span>:String</code> &mdash; The event type; indicates the action that triggered the event.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">bubbles</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the event can bubble
      up the display list hierarchy.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">cancelable</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the behavior
      associated with the event can be prevented.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">kind</span>:String</code> (default = <code>null</code>)<code></code> &mdash; Indicates the kind of event that occured.
      The parameter value can be one of the values in the CollectionEventKind 
   class, or <code>null</code>, which indicates that the kind is unknown.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">location</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; When the <code>kind</code> is
      <code>CollectionEventKind.ADD</code>,
      <code>CollectionEventKind.MOVE</code>,
      <code>CollectionEventKind.REMOVE</code>, or
      <code>CollectionEventKind.REPLACE</code>,
      this value indicates at what location the item(s) specified
      in the <code>items property</code> can be found
      within the target collection.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">oldLocation</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; When the <code>kind</code> is
      <code>CollectionEventKind.MOVE</code>, this value indicates
      the old location within the target collection
      of the item(s) specified in the <code>items</code> property.
            </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">items</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; Array of objects with information about the items 
   affected by the event, as described in the <code>items</code> property.
      When the <code>kind</code> is <code>CollectionEventKind.REFRESH</code>
      or <code>CollectionEventKind.RESET</code>, this Array has zero length.
     </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="COLLECTION_CHANGE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">COLLECTION_CHANGE</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const COLLECTION_CHANGE:String = "collectionChange"</code><p>
      The CollectionEvent.COLLECTION_CHANGE constant defines the value of the
      <code>type</code> property of the event object for an event that is
      dispatched when a collection has changed.
           </p><p>The properties of the event object have the following values.
      Not all properties are meaningful for all kinds of events.
   See the detailed property descriptions for more information.</p>
      <table class="innertable">
         <tr><th>Property</th><th>Value</th></tr>
         <tr><td><code>bubbles</code></td><td>false</td></tr>
         <tr><td><code>cancelable</code></td><td>false</td></tr>
         <tr><td><code>currentTarget</code></td><td>The Object that defines the
           event listener that handles the event. For example, if you use
           <code>myButton.addEventListener()</code> to register an event listener,
           myButton is the value of the <code>currentTarget</code>. </td></tr>
         <tr><td><code>items</code></td><td>An Array of objects with
           information about the items affected by the event.
     The contents of this field depend on the event kind;
        for details see the <code>items</code> property</td></tr>
         <tr><td><code>kind</code></td><td>The kind of event.
           The valid values are defined in the CollectionEventKind 
        class as constants.</td></tr>
         <tr><td><code>location</code></td><td>Location within the target collection
             of the item(s) specified in the <code>items</code> property.</td></tr>
         <tr><td><code>oldLocation</code></td><td>the previous location in the collection
             of the item specified in the <code>items</code> property.</td></tr>
         <tr><td><code>target</code></td><td>The Object that dispatched the event;
           it is not always the Object listening for the event.
           Use the <code>currentTarget</code> property to always access the
           Object listening for the event.</td></tr>
         <tr><td><code>type</code></td><td>CollectionEvent.COLLECTION_CHANGE</td></tr>
      </table>
           </div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
